<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>BOFRecord (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="BOFRecord (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BOFRecord.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/record/BlankRecord.html" title="class in org.apache.poi.hssf.record"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hssf/record/BookBoolRecord.html" title="class in org.apache.poi.hssf.record"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/record/BOFRecord.html" target="_top">FRAMES</a></li>
<li><a href="BOFRecord.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hssf.record</p>
<h2 title="Class BOFRecord" class="title">Class BOFRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/hssf/record/RecordBase.html" title="class in org.apache.poi.hssf.record">org.apache.poi.hssf.record.RecordBase</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">org.apache.poi.hssf.record.Record</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html" title="class in org.apache.poi.hssf.record">org.apache.poi.hssf.record.StandardRecord</a></li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hssf.record.BOFRecord</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <strong>BOFRecord</strong>
extends <a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html" title="class in org.apache.poi.hssf.record">StandardRecord</a></pre>
<div class="block">Title: Beginning Of File (0x0809)<P>
 Description: Somewhat of a misnomer, its used for the beginning of a set of
              records that have a particular purpose or subject.
              Used in sheets and workbooks.<P>
 REFERENCE:  PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Andrew C. Oliver, Jason Height (jheight at chariot dot net dot au)</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff2_sid">biff2_sid</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff3_sid">biff3_sid</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff4_sid">biff4_sid</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff5_sid">biff5_sid</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BUILD">BUILD</a></strong></code>
<div class="block">suggested default 0x10d3</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BUILD_YEAR">BUILD_YEAR</a></strong></code>
<div class="block">suggested default  0x07CC (1996)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#HISTORY_MASK">HISTORY_MASK</a></strong></code>
<div class="block">suggested default for a normal sheet (0x41)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#sid">sid</a></strong></code>
<div class="block">for BIFF8 files the BOF is 0x809.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_CHART">TYPE_CHART</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_EXCEL_4_MACRO">TYPE_EXCEL_4_MACRO</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_VB_MODULE">TYPE_VB_MODULE</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKBOOK">TYPE_WORKBOOK</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKSHEET">TYPE_WORKSHEET</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKSPACE_FILE">TYPE_WORKSPACE_FILE</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#VERSION">VERSION</a></strong></code>
<div class="block">suggested default (0x0600 - BIFF8)</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BOFRecord()">BOFRecord</a></strong>()</code>
<div class="block">Constructs an empty BOFRecord with no fields set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BOFRecord(org.apache.poi.hssf.record.RecordInputStream)">BOFRecord</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/RecordInputStream.html" title="class in org.apache.poi.hssf.record">RecordInputStream</a>&nbsp;in)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#clone()">clone</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html" title="class in org.apache.poi.hssf.record">BOFRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#createSheetBOF()">createSheetBOF</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getBuild()">getBuild</a></strong>()</code>
<div class="block">get the build that wrote this file</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getBuildYear()">getBuildYear</a></strong>()</code>
<div class="block">Year of the build that wrote this file</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getDataSize()">getDataSize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getHistoryBitMask()">getHistoryBitMask</a></strong>()</code>
<div class="block">get the history bit mask (not very useful)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getRequiredVersion()">getRequiredVersion</a></strong>()</code>
<div class="block">get the minimum version required to read this file</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getSid()">getSid</a></strong>()</code>
<div class="block">return the non static version of the id for this record.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getType()">getType</a></strong>()</code>
<div class="block">type of object this marks</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#getVersion()">getVersion</a></strong>()</code>
<div class="block">Version number - for BIFF8 should be 0x06</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#serialize(org.apache.poi.util.LittleEndianOutput)">serialize</a></strong>(<a href="../../../../../org/apache/poi/util/LittleEndianOutput.html" title="interface in org.apache.poi.util">LittleEndianOutput</a>&nbsp;out)</code>
<div class="block">Write the data content of this BIFF record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#setBuild(int)">setBuild</a></strong>(int&nbsp;build)</code>
<div class="block">build that wrote this file</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#setBuildYear(int)">setBuildYear</a></strong>(int&nbsp;year)</code>
<div class="block">Year of the build that wrote this file</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#setHistoryBitMask(int)">setHistoryBitMask</a></strong>(int&nbsp;bitmask)</code>
<div class="block">set the history bit mask (not very useful)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#setRequiredVersion(int)">setRequiredVersion</a></strong>(int&nbsp;version)</code>
<div class="block">set the minimum version required to read this file</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#setType(int)">setType</a></strong>(int&nbsp;type)</code>
<div class="block">type of object this marks</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#setVersion(int)">setVersion</a></strong>(int&nbsp;version)</code>
<div class="block">Version number - for BIFF8 should be 0x06</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#toString()">toString</a></strong>()</code>
<div class="block">get a string representation of the record (for biffview/debugging)</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hssf.record.StandardRecord">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.hssf.record.<a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html" title="class in org.apache.poi.hssf.record">StandardRecord</a></h3>
<code><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html#getRecordSize()">getRecordSize</a>, <a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html#serialize(int, byte[])">serialize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hssf.record.Record">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.hssf.record.<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></h3>
<code><a href="../../../../../org/apache/poi/hssf/record/Record.html#cloneViaReserialise()">cloneViaReserialise</a>, <a href="../../../../../org/apache/poi/hssf/record/Record.html#serialize()">serialize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="sid">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sid</h4>
<pre>public static final&nbsp;short sid</pre>
<div class="block">for BIFF8 files the BOF is 0x809. For earlier versions see
  <a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff2_sid"><code>biff2_sid</code></a> <a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff3_sid"><code>biff3_sid</code></a> <a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff4_sid"><code>biff4_sid</code></a> 
  <a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#biff5_sid"><code>biff5_sid</code></a></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.sid">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="biff2_sid">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>biff2_sid</h4>
<pre>public static final&nbsp;short biff2_sid</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.biff2_sid">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="biff3_sid">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>biff3_sid</h4>
<pre>public static final&nbsp;short biff3_sid</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.biff3_sid">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="biff4_sid">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>biff4_sid</h4>
<pre>public static final&nbsp;short biff4_sid</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.biff4_sid">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="biff5_sid">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>biff5_sid</h4>
<pre>public static final&nbsp;short biff5_sid</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.biff5_sid">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="VERSION">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERSION</h4>
<pre>public static final&nbsp;int VERSION</pre>
<div class="block">suggested default (0x0600 - BIFF8)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.VERSION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="BUILD">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUILD</h4>
<pre>public static final&nbsp;int BUILD</pre>
<div class="block">suggested default 0x10d3</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.BUILD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="BUILD_YEAR">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BUILD_YEAR</h4>
<pre>public static final&nbsp;int BUILD_YEAR</pre>
<div class="block">suggested default  0x07CC (1996)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.BUILD_YEAR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="HISTORY_MASK">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HISTORY_MASK</h4>
<pre>public static final&nbsp;int HISTORY_MASK</pre>
<div class="block">suggested default for a normal sheet (0x41)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.HISTORY_MASK">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_WORKBOOK">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_WORKBOOK</h4>
<pre>public static final&nbsp;int TYPE_WORKBOOK</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.TYPE_WORKBOOK">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_VB_MODULE">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_VB_MODULE</h4>
<pre>public static final&nbsp;int TYPE_VB_MODULE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.TYPE_VB_MODULE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_WORKSHEET">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_WORKSHEET</h4>
<pre>public static final&nbsp;int TYPE_WORKSHEET</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.TYPE_WORKSHEET">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_CHART">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_CHART</h4>
<pre>public static final&nbsp;int TYPE_CHART</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.TYPE_CHART">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_EXCEL_4_MACRO">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_EXCEL_4_MACRO</h4>
<pre>public static final&nbsp;int TYPE_EXCEL_4_MACRO</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.TYPE_EXCEL_4_MACRO">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_WORKSPACE_FILE">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TYPE_WORKSPACE_FILE</h4>
<pre>public static final&nbsp;int TYPE_WORKSPACE_FILE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.record.BOFRecord.TYPE_WORKSPACE_FILE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="BOFRecord()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BOFRecord</h4>
<pre>public&nbsp;BOFRecord()</pre>
<div class="block">Constructs an empty BOFRecord with no fields set.</div>
</li>
</ul>
<a name="BOFRecord(org.apache.poi.hssf.record.RecordInputStream)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BOFRecord</h4>
<pre>public&nbsp;BOFRecord(<a href="../../../../../org/apache/poi/hssf/record/RecordInputStream.html" title="class in org.apache.poi.hssf.record">RecordInputStream</a>&nbsp;in)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createSheetBOF()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSheetBOF</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html" title="class in org.apache.poi.hssf.record">BOFRecord</a>&nbsp;createSheetBOF()</pre>
</li>
</ul>
<a name="setVersion(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVersion</h4>
<pre>public&nbsp;void&nbsp;setVersion(int&nbsp;version)</pre>
<div class="block">Version number - for BIFF8 should be 0x06</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>version</code> - version to be set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#VERSION"><code>VERSION</code></a></dd></dl>
</li>
</ul>
<a name="setType(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre>public&nbsp;void&nbsp;setType(int&nbsp;type)</pre>
<div class="block">type of object this marks</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type to be set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKBOOK"><code>TYPE_WORKBOOK</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_VB_MODULE"><code>TYPE_VB_MODULE</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKSHEET"><code>TYPE_WORKSHEET</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_CHART"><code>TYPE_CHART</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_EXCEL_4_MACRO"><code>TYPE_EXCEL_4_MACRO</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKSPACE_FILE"><code>TYPE_WORKSPACE_FILE</code></a></dd></dl>
</li>
</ul>
<a name="setBuild(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBuild</h4>
<pre>public&nbsp;void&nbsp;setBuild(int&nbsp;build)</pre>
<div class="block">build that wrote this file</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>build</code> - build number to set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BUILD"><code>BUILD</code></a></dd></dl>
</li>
</ul>
<a name="setBuildYear(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBuildYear</h4>
<pre>public&nbsp;void&nbsp;setBuildYear(int&nbsp;year)</pre>
<div class="block">Year of the build that wrote this file</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>year</code> - build year to set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BUILD_YEAR"><code>BUILD_YEAR</code></a></dd></dl>
</li>
</ul>
<a name="setHistoryBitMask(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHistoryBitMask</h4>
<pre>public&nbsp;void&nbsp;setHistoryBitMask(int&nbsp;bitmask)</pre>
<div class="block">set the history bit mask (not very useful)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bitmask</code> - bitmask to set for the history</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#HISTORY_MASK"><code>HISTORY_MASK</code></a></dd></dl>
</li>
</ul>
<a name="setRequiredVersion(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequiredVersion</h4>
<pre>public&nbsp;void&nbsp;setRequiredVersion(int&nbsp;version)</pre>
<div class="block">set the minimum version required to read this file</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>version</code> - version to set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#VERSION"><code>VERSION</code></a></dd></dl>
</li>
</ul>
<a name="getVersion()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>public&nbsp;int&nbsp;getVersion()</pre>
<div class="block">Version number - for BIFF8 should be 0x06</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>version number of the generator of this file</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#VERSION"><code>VERSION</code></a></dd></dl>
</li>
</ul>
<a name="getType()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;int&nbsp;getType()</pre>
<div class="block">type of object this marks</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>type of object</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKBOOK"><code>TYPE_WORKBOOK</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_VB_MODULE"><code>TYPE_VB_MODULE</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKSHEET"><code>TYPE_WORKSHEET</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_CHART"><code>TYPE_CHART</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_EXCEL_4_MACRO"><code>TYPE_EXCEL_4_MACRO</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#TYPE_WORKSPACE_FILE"><code>TYPE_WORKSPACE_FILE</code></a></dd></dl>
</li>
</ul>
<a name="getBuild()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuild</h4>
<pre>public&nbsp;int&nbsp;getBuild()</pre>
<div class="block">get the build that wrote this file</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>short build number of the generator of this file</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BUILD"><code>BUILD</code></a></dd></dl>
</li>
</ul>
<a name="getBuildYear()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuildYear</h4>
<pre>public&nbsp;int&nbsp;getBuildYear()</pre>
<div class="block">Year of the build that wrote this file</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>short build year of the generator of this file</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#BUILD_YEAR"><code>BUILD_YEAR</code></a></dd></dl>
</li>
</ul>
<a name="getHistoryBitMask()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHistoryBitMask</h4>
<pre>public&nbsp;int&nbsp;getHistoryBitMask()</pre>
<div class="block">get the history bit mask (not very useful)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>int bitmask showing the history of the file (who cares!)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#HISTORY_MASK"><code>HISTORY_MASK</code></a></dd></dl>
</li>
</ul>
<a name="getRequiredVersion()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequiredVersion</h4>
<pre>public&nbsp;int&nbsp;getRequiredVersion()</pre>
<div class="block">get the minimum version required to read this file</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>int least version that can read the file</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/BOFRecord.html#VERSION"><code>VERSION</code></a></dd></dl>
</li>
</ul>
<a name="toString()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/Record.html#toString()">Record</a></code></strong></div>
<div class="block">get a string representation of the record (for biffview/debugging)</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/hssf/record/Record.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></code></dd>
</dl>
</li>
</ul>
<a name="serialize(org.apache.poi.util.LittleEndianOutput)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public&nbsp;void&nbsp;serialize(<a href="../../../../../org/apache/poi/util/LittleEndianOutput.html" title="interface in org.apache.poi.util">LittleEndianOutput</a>&nbsp;out)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html#serialize(org.apache.poi.util.LittleEndianOutput)">StandardRecord</a></code></strong></div>
<div class="block">Write the data content of this BIFF record.  The 'ushort sid' and 'ushort size' header fields
 have already been written by the superclass.<br/>

 The number of bytes written must equal the record size reported by
  <a href="../../../../../org/apache/poi/hssf/record/RecordBase.html#getRecordSize()"><code>RecordBase.getRecordSize()</code></a>} minus four
  ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  by thye superclass).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html#serialize(org.apache.poi.util.LittleEndianOutput)">serialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html" title="class in org.apache.poi.hssf.record">StandardRecord</a></code></dd>
</dl>
</li>
</ul>
<a name="getDataSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataSize</h4>
<pre>protected&nbsp;int&nbsp;getDataSize()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html#getDataSize()">getDataSize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/StandardRecord.html" title="class in org.apache.poi.hssf.record">StandardRecord</a></code></dd>
</dl>
</li>
</ul>
<a name="getSid()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSid</h4>
<pre>public&nbsp;short&nbsp;getSid()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/Record.html#getSid()">Record</a></code></strong></div>
<div class="block">return the non static version of the id for this record.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/hssf/record/Record.html#getSid()">getSid</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></code></dd>
</dl>
</li>
</ul>
<a name="clone()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;java.lang.Object&nbsp;clone()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/hssf/record/Record.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BOFRecord.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/record/BlankRecord.html" title="class in org.apache.poi.hssf.record"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hssf/record/BookBoolRecord.html" title="class in org.apache.poi.hssf.record"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/record/BOFRecord.html" target="_top">FRAMES</a></li>
<li><a href="BOFRecord.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
